Huge News!Announcing our $40M Series B led by Abstract Ventures.Learn More →

@hebcal/core

Package Overview

Dependencies

Advanced tools

Install Socket

Detect and block malicious and high-risk dependencies

Install

@hebcal/core

A perpetual Jewish Calendar API

2.13.0
Source
npm

Version published: 4 years ago

Weekly downloads: 3.1K; increased by120.65%

Maintainers: 1

Weekly downloads

Created: 4 years ago

Source

hebcal-es6

Hebcal is a perpetual Jewish Calendar. This library converts between Hebrew and Gregorian dates, and generates lists of Jewish holidays for any year (past, present or future). Shabbat and holiday candle lighting and havdalah times are approximated based on location. Torah readings (Parashat HaShavua), Daf Yomi, and counting of the Omer can also be specified. Hebcal also includes algorithms to calculate yahrzeits, birthdays and anniversaries.

Hebcal was created in 1994 by Danny Sadinoff as a Unix/Linux program written in C, inspired by similar functionality written in Emacs Lisp. This ECMAScript 2015 implementation targets browser-based JavaScript and server-side Node.js.

Many users of this library will utilize the HebrewCalendar.calendar() and HDate interfaces.

Installation

$ npm install @hebcal/core

Synopsis

import {HebrewCalendar, HDate, Location, Event} from '@hebcal/core';

const options = {
  year: 1981,
  isHebrewYear: false,
  candlelighting: true,
  location: Location.lookup('San Francisco'),
  sedrot: true,
  omer: true,
};
const events = HebrewCalendar.calendar(options);

for (const ev of events) {
  const hd = ev.getDate();
  const date = hd.greg();
  console.log(date.toLocaleDateString(), ev.render(), hd.toString());
}

Classes

Event: Represents an Event with a title, date, and flags
HDate: Represents a Hebrew date
HebrewDateEvent: Daily Hebrew date ("11th of Sivan, 5780")
Zmanim: Class representing halachic times
Location: Class representing Location
TimedEvent: An event that has an eventTime and eventTimeStr
HavdalahEvent: Havdalah after Shabbat or holiday
CandleLightingEvent: Candle lighting before Shabbat or holiday
Molad: Represents a molad, the moment when the new moon is "born"
MoladEvent: Represents a Molad announcement on Shabbat Mevarchim
OmerEvent: Represents a day 1-49 of counting the Omer from Pesach to Shavuot
DafYomi: Returns the Daf Yomi for given date
DafYomiEvent: Event wrapper around a DafYomi instance
Sedra: Represents Parashah HaShavua for an entire Hebrew year
ParshaEvent: Represents one of 54 weekly Torah portions, always on a Saturday
HolidayEvent: Represents a built-in holiday like Pesach, Purim or Tu BiShvat
RoshChodeshEvent: Represents Rosh Chodesh, the beginning of a new month
MevarchimChodeshEvent: Represents Mevarchim haChodesh, the announcement of the new month

Objects

greg : object

Gregorian date helper functions.

Locale : object

A locale in Hebcal is used for translations/transliterations of holidays. @hebcal/core supports three locales by default

en - default, Sephardic transliterations (e.g. "Shabbat")
ashkenazi - Ashkenazi transliterations (e.g. "Shabbos")
he - Hebrew (e.g. "שַׁבָּת")

Constants

parshiot : Array.<string>: The 54 parshiyot of the Torah as transilterated strings parshiot[0] == 'Bereshit', parshiot[1] == 'Noach', parshiot[53] == 'Ha'Azinu'.
HebrewCalendar: HebrewCalendar is the main interface to the @hebcal/core library. This namespace is used to calculate holidays, rosh chodesh, candle lighting & havdalah times, Parashat HaShavua, Daf Yomi, days of the omer, and the molad. Event names can be rendered in several languges using the locale option.

Typedefs

ZmanimTimesResult : Object

Event

Represents an Event with a title, date, and flags

Kind: global class

Event
- new Event(date, desc, [mask], [attrs])
- .getDate() ⇒ HDate
- .getDesc() ⇒ string
- .getFlags() ⇒ number
- .render([locale]) ⇒ string
- .renderBrief([locale]) ⇒ string
- .basename() ⇒ string
- .url() ⇒ string
- .observedInIsrael() ⇒ boolean
- .observedInDiaspora() ⇒ boolean
- ~~.getAttrs() ⇒ Object~~

new Event(date, desc, [mask], [attrs])

Constructs Event

Param	Type	Default	Description
date	`HDate`		Hebrew date event occurs
desc	`string`		Description (not translated)
[mask]	`number`	`0`	optional bitmask of holiday flags (see flags)
[attrs]	`Object`	`{}`	optional additional attributes (e.g. `eventTimeStr`, `cholHaMoedDay`)

event.getDate() ⇒ `HDate`

Hebrew date of this event

Kind: instance method of Event

event.getDesc() ⇒ `string`

Untranslated description of this event

Kind: instance method of Event

event.getFlags() ⇒ `number`

Bitmask of optional event flags. See flags

Kind: instance method of Event

event.render([locale]) ⇒ `string`

Returns (translated) description of this event

Kind: instance method of Event

Param	Type	Description
[locale]	`string`	Optional locale name (defaults to active locale).

Example

const ev = new Event(new HDate(6, 'Sivan', 5749), 'Shavuot', flags.CHAG);
ev.render(); // 'Shavuot'
ev.render('he'); // 'שָׁבוּעוֹת'
ev.render('ashkenazi'); // 'Shavuos'

event.renderBrief([locale]) ⇒ `string`

Returns a brief (translated) description of this event. For most events, this is the same as render(). For some events, it procudes a shorter text (e.g. without a time or added description).

Kind: instance method of Event

Param	Type	Description
[locale]	`string`	Optional locale name (defaults to active locale).

event.basename() ⇒ `string`

Returns a simplified (untranslated) description for this event. For example, the HolidayEvent class supports "Erev Pesach" => "Pesach", and "Sukkot III (CH''M)" => "Sukkot". For many holidays the basename and the event description are the same.

Kind: instance method of Event

event.url() ⇒ `string`

Returns a URL to hebcal.com or sefaria.org for more detail on the event. Returns undefined for events with no detail page.

Kind: instance method of Event

event.observedInIsrael() ⇒ `boolean`

Is this event observed in Israel?

Kind: instance method of Event
Example

const ev1 = new Event(new HDate(7, 'Sivan', 5749), 'Shavuot II', flags.CHAG | flags.CHUL_ONLY);
ev1.observedInIsrael(); // false
const ev2 = new Event(new HDate(26, 'Kislev', 5749), 'Chanukah: 3 Candles', 0);
ev2.observedInIsrael(); // true

event.observedInDiaspora() ⇒ `boolean`

Is this event observed in the Diaspora?

Kind: instance method of Event
Example

const ev1 = new Event(new HDate(7, 'Sivan', 5749), 'Shavuot II', flags.CHAG | flags.CHUL_ONLY);
ev1.observedInDiaspora(); // true
const ev2 = new Event(new HDate(26, 'Kislev', 5749), 'Chanukah: 3 Candles', 0);
ev2.observedInDiaspora(); // true

event.getAttrs() ⇒ `Object`

Deprecated

Kind: instance method of Event

HDate

Represents a Hebrew date

Kind: global class

HDate
- new HDate([day], [month], [year])
- instance
  - .getFullYear() ⇒ number
  - .isLeapYear() ⇒ boolean
  - .getMonth() ⇒ number
  - .getTishreiMonth() ⇒ number
  - .daysInMonth() ⇒ number
  - .getDate() ⇒ number
  - .getDay() ⇒ number
  - .greg() ⇒ Date
  - .abs() ⇒ number
  - .getMonthName() ⇒ string
  - .render([locale]) ⇒ string
  - .renderGematriya() ⇒ string
  - .before(day) ⇒ HDate
  - .onOrBefore(dow) ⇒ HDate
  - .nearest(dow) ⇒ HDate
  - .onOrAfter(dow) ⇒ HDate
  - .after(day) ⇒ HDate
  - .next() ⇒ HDate
  - .prev() ⇒ HDate
  - .isSameDate(other) ⇒ boolean
  - .toString() ⇒ string
- static
  - .hebrew2abs(year, month, day) ⇒ number
  - .isLeapYear(year) ⇒ boolean
  - .monthsInYear(year) ⇒ number
  - .daysInMonth(month, year) ⇒ number
  - .getMonthName(month, year) ⇒ string
  - .monthNum(month) ⇒ number
  - .elapsedDays(year) ⇒ number
  - .daysInYear(year) ⇒ number
  - .longCheshvan(year) ⇒ boolean
  - .shortKislev(year) ⇒ boolean
  - .monthFromName(monthName) ⇒ number
  - .dayOnOrBefore(dayOfWeek, absdate) ⇒ number

new HDate([day], [month], [year])

Create a Hebrew date. There are 3 basic forms for the HDate() constructor.

No parameters - represents the current Hebrew date at time of instantiation
One parameter
- Date - represents the Hebrew date corresponding to the Gregorian date using local time. Hours, minutes, seconds and milliseconds are ignored.
- HDate - clones a copy of the given Hebrew date
- number - Converts absolute R.D. days to Hebrew date. R.D. 1 == the imaginary date January 1, 1 (Gregorian)
Three parameters: Hebrew day, Hebrew month, Hebrew year. Hebrew day should be a number between 1-30, Hebrew month can be a number or string, and Hebrew year is always a number.

Param	Type	Description
[day]	`number` \| `Date` \| `HDate`	Day of month (1-30) if a `number`. If a `Date` is specified, represents the Hebrew date corresponding to the Gregorian date using local time. If an `HDate` is specified, clones a copy of the given Hebrew date.
[month]	`number` \| `string`	Hebrew month of year (1=NISAN, 7=TISHREI)
[year]	`number`	Hebrew year

Example

import {HDate, months} from '@hebcal/core';

const hd1 = new HDate();
const hd2 = new HDate(new Date(2008, 10, 13));
const hd3 = new HDate(15, 'Cheshvan', 5769);
const hd4 = new HDate(15, months.CHESHVAN, 5769);
const hd5 = new HDate(733359); // ==> 15 Cheshvan 5769
const monthName = 'אייר';
const hd6 = new HDate(5, monthName, 5773);

hDate.getFullYear() ⇒ `number`

Gets the Hebrew year of this Hebrew date

Kind: instance method of HDate

hDate.isLeapYear() ⇒ `boolean`

Tests if this date occurs during a leap year

Kind: instance method of HDate

hDate.getMonth() ⇒ `number`

Gets the Hebrew month (1=NISAN, 7=TISHREI) of this Hebrew date

Kind: instance method of HDate

hDate.getTishreiMonth() ⇒ `number`

The Tishrei-based month of the date. 1 is Tishrei, 7 is Nisan, 13 is Elul in a leap year

Kind: instance method of HDate

hDate.daysInMonth() ⇒ `number`

Number of days in the month of this Hebrew date

Kind: instance method of HDate

hDate.getDate() ⇒ `number`

Gets the day within the month (1-30)

Kind: instance method of HDate

hDate.getDay() ⇒ `number`

Gets the day of the week, using local time. 0=Sunday, 6=Saturday

Kind: instance method of HDate

hDate.greg() ⇒ `Date`

Converts to Gregorian date

Kind: instance method of HDate

hDate.abs() ⇒ `number`

Returns R.D. (Rata Die) fixed days. R.D. 1 == Monday, January 1, 1 (Gregorian) Note also that R.D. = Julian Date − 1,721,424.5 https://en.wikipedia.org/wiki/Rata_Die#Dershowitz_and_Reingold

Kind: instance method of HDate

hDate.getMonthName() ⇒ `string`

Returns a transliterated Hebrew month name, e.g. 'Elul' or 'Cheshvan'.

Kind: instance method of HDate

hDate.render([locale]) ⇒ `string`

Renders this Hebrew date as a translated or transliterated string, including ordinal e.g. '15th of Cheshvan, 5769'.

Kind: instance method of HDate

Param	Type	Description
[locale]	`string`	Optional locale name (defaults to active locale).

Example

import {HDate, months} from '@hebcal/core';

const hd = new HDate(15, months.CHESHVAN, 5769);
console.log(hd.render()); // '15th of Cheshvan, 5769'
console.log(hd.render('he')); // '15 חֶשְׁוָן, 5769'

hDate.renderGematriya() ⇒ `string`

Renders this Hebrew date in Hebrew gematriya, regardless of locale.

Kind: instance method of HDate
Example

import {HDate, months} from '@hebcal/core';
const hd = new HDate(15, months.CHESHVAN, 5769);
console.log(ev.renderGematriya()); // 'ט״ו חֶשְׁוָן תשס״ט'

hDate.before(day) ⇒ `HDate`

Returns an HDate representing the a dayNumber before the current date. Sunday=0, Saturday=6

Kind: instance method of HDate

Param	Type	Description
day	`number`	day of week

Example

new HDate(new Date('Wednesday February 19, 2014')).before(6).greg() // Sat Feb 15 2014

hDate.onOrBefore(dow) ⇒ `HDate`

Returns an HDate representing the a dayNumber on or before the current date. Sunday=0, Saturday=6

Kind: instance method of HDate

Param	Type	Description
dow	`number`	day of week

Example

new HDate(new Date('Wednesday February 19, 2014')).onOrBefore(6).greg() // Sat Feb 15 2014
new HDate(new Date('Saturday February 22, 2014')).onOrBefore(6).greg() // Sat Feb 22 2014
new HDate(new Date('Sunday February 23, 2014')).onOrBefore(6).greg() // Sat Feb 22 2014

hDate.nearest(dow) ⇒ `HDate`

Returns an HDate representing the nearest dayNumber to the current date Sunday=0, Saturday=6

Kind: instance method of HDate

Param	Type	Description
dow	`number`	day of week

Example

new HDate(new Date('Wednesday February 19, 2014')).nearest(6).greg() // Sat Feb 22 2014
new HDate(new Date('Tuesday February 18, 2014')).nearest(6).greg() // Sat Feb 15 2014

hDate.onOrAfter(dow) ⇒ `HDate`

Returns an HDate representing the a dayNumber on or after the current date. Sunday=0, Saturday=6

Kind: instance method of HDate

Param	Type	Description
dow	`number`	day of week

Example

new HDate(new Date('Wednesday February 19, 2014')).onOrAfter(6).greg() // Sat Feb 22 2014
new HDate(new Date('Saturday February 22, 2014')).onOrAfter(6).greg() // Sat Feb 22 2014
new HDate(new Date('Sunday February 23, 2014')).onOrAfter(6).greg() // Sat Mar 01 2014

hDate.after(day) ⇒ `HDate`

Returns an HDate representing the a dayNumber after the current date. Sunday=0, Saturday=6

Kind: instance method of HDate

Param	Type	Description
day	`number`	day of week

Example

new HDate(new Date('Wednesday February 19, 2014')).after(6).greg() // Sat Feb 22 2014
new HDate(new Date('Saturday February 22, 2014')).after(6).greg() // Sat Mar 01 2014
new HDate(new Date('Sunday February 23, 2014')).after(6).greg() // Sat Mar 01 2014

hDate.next() ⇒ `HDate`

Returns the next Hebrew date

Kind: instance method of HDate

hDate.prev() ⇒ `HDate`

Returns the previous Hebrew date

Kind: instance method of HDate

hDate.isSameDate(other) ⇒ `boolean`

Compares this date to another date, returning true if the dates match.

Kind: instance method of HDate

Param	Type	Description
other	`HDate`	Hebrew date to compare

hDate.toString() ⇒ `string`

Kind: instance method of HDate

HDate.hebrew2abs(year, month, day) ⇒ `number`

Converts Hebrew date to R.D. (Rata Die) fixed days. R.D. 1 is the imaginary date Monday, January 1, 1 on the Gregorian Calendar.

Kind: static method of HDate

Param	Type	Description
year	`number`	Hebrew year
month	`number`	Hebrew month
day	`number`	Hebrew date (1-30)

HDate.isLeapYear(year) ⇒ `boolean`

Returns true if Hebrew year is a leap year

Kind: static method of HDate

Param	Type	Description
year	`number`	Hebrew year

HDate.monthsInYear(year) ⇒ `number`

Number of months in this Hebrew year (either 12 or 13 depending on leap year)

Kind: static method of HDate

Param	Type	Description
year	`number`	Hebrew year

HDate.daysInMonth(month, year) ⇒ `number`

Number of days in Hebrew month in a given year (29 or 30)

Kind: static method of HDate

Param	Type	Description
month	`number`	Hebrew month (e.g. months.TISHREI)
year	`number`	Hebrew year

HDate.getMonthName(month, year) ⇒ `string`

Returns a transliterated string name of Hebrew month in year, for example 'Elul' or 'Cheshvan'.

Kind: static method of HDate

Param	Type	Description
month	`number`	Hebrew month (e.g. months.TISHREI)
year	`number`	Hebrew year

HDate.monthNum(month) ⇒ `number`

Returns the Hebrew month number (NISAN=1, TISHREI=7)

Kind: static method of HDate

Param	Type	Description
month	`number` \| `string`	A number, or Hebrew month name string

HDate.elapsedDays(year) ⇒ `number`

Days from sunday prior to start of Hebrew calendar to mean conjunction of Tishrei in Hebrew YEAR

Kind: static method of HDate

Param	Type	Description
year	`number`	Hebrew year

HDate.daysInYear(year) ⇒ `number`

Number of days in the hebrew YEAR

Kind: static method of HDate

Param	Type	Description
year	`number`	Hebrew year

HDate.longCheshvan(year) ⇒ `boolean`

true if Cheshvan is long in Hebrew year

Kind: static method of HDate

Param	Type	Description
year	`number`	Hebrew year

HDate.shortKislev(year) ⇒ `boolean`

true if Kislev is short in Hebrew year

Kind: static method of HDate

Param	Type	Description
year	`number`	Hebrew year

HDate.monthFromName(monthName) ⇒ `number`

Converts Hebrew month string name to numeric

Kind: static method of HDate

Param	Type	Description
monthName	`string`	monthName

HDate.dayOnOrBefore(dayOfWeek, absdate) ⇒ `number`

Note: Applying this function to d+6 gives us the DAYNAME on or after an absolute day d. Similarly, applying it to d+3 gives the DAYNAME nearest to absolute date d, applying it to d-1 gives the DAYNAME previous to absolute date d, and applying it to d+7 gives the DAYNAME following absolute date d.

Kind: static method of HDate

Param	Type
dayOfWeek	`number`
absdate	`number`

HebrewDateEvent

Daily Hebrew date ("11th of Sivan, 5780")

Kind: global class

HebrewDateEvent
- new HebrewDateEvent(date)
- instance
  - .render([locale]) ⇒ string
- static
  - .renderHebrew(day, monthName, fullYear) ⇒ string

new HebrewDateEvent(date)

Param	Type
date	`HDate`

hebrewDateEvent.render([locale]) ⇒ `string`

Kind: instance method of HebrewDateEvent

Param	Type	Description
[locale]	`string`	Optional locale name (defaults to active locale).

Example

import {HDate, HebrewDateEvent, months} from '@hebcal/core';

const hd = new HDate(15, months.CHESHVAN, 5769);
const ev = new HebrewDateEvent(hd);
console.log(ev.render()); // '15th of Cheshvan, 5769'
console.log(ev.render('he')); // 'ט״ו חֶשְׁוָן תשס״ט'

HebrewDateEvent.renderHebrew(day, monthName, fullYear) ⇒ `string`

Helper function to render a Hebrew date

Kind: static method of HebrewDateEvent

Param	Type
day	`number`
monthName	`string`
fullYear	`number`

Zmanim

Class representing halachic times

Kind: global class

Zmanim
- new Zmanim(date, latitude, longitude)
- .suntime() ⇒ ZmanimTimesResult
- .sunrise() ⇒ Date
- .sunset() ⇒ Date
- .dawn() ⇒ Date
- .dusk() ⇒ Date
- .hour() ⇒ number
- .hourMins() ⇒ number
- .gregEve() ⇒ Date
- .nightHour() ⇒ number
- .nightHourMins() ⇒ number
- .hourOffset(hours) ⇒ Date
- .chatzot() ⇒ Date
- .chatzotNight() ⇒ Date
- .alotHaShachar() ⇒ Date
- .misheyakir() ⇒ Date
- .misheyakirMachmir() ⇒ Date
- .sofZmanShma() ⇒ Date
- .sofZmanTfilla() ⇒ Date
- .minchaGedola() ⇒ Date
- .minchaKetana() ⇒ Date
- .plagHaMincha() ⇒ Date
- .tzeit([angle]) ⇒ Date
- .neitzHaChama() ⇒ Date
- .shkiah() ⇒ Date